set

type set<T: -immutable> : collection<T>

A mutable set of elements of type T, where T is immutable. Subtype of collection<T>. Implemented as a hash-set, with iteration order determined by the order in which the elements were added.

Since

0.6.0

Constructors

set

pure constructor()

Construct a new empty set.

pure constructor(values: iterable<-T>)

Construct a new set by copying the values from another iterable.

Functions

add

function add(value: T): boolean

Append an element to the end of this collection.

The element is not added if this collection does not allow duplicates and the element is already contained in this collection.

add_all

function add_all(values: collection<-T>): boolean

Add all elements from another collection to the end of this collection.

If this collection does not allow duplicates, then only those elements not already contained in this collection are added.

add_all_copy

function add_all_copy(values: collection<-T>): set<T>

Returns a new set containing the elements of this set and the elements of a given collection.

a.add_all_copy(b) is equivalent to a + b, where a and b are sets.

Examples:

set([1]).add_all_copy(set([1])) returns set([1])
set([1, 2, 3]).add_all_copy(set([2, 3, 4])) returns set([1, 2, 3, 4])

addAll

(alias) function ~~addAll~~(values: collection<-T>): boolean

Add all elements from another collection to the end of this collection.

If this collection does not allow duplicates, then only those elements not already contained in this collection are added.

Alias

add_all

clear

function clear()

Clear this collection; i.e. remove all its elements. Immediately after this method returns, this collection is empty.

contains

pure function contains(value: T): boolean

Check if this collection contains the given element.

contains_all

pure function contains_all(values: collection<-T>): boolean

Check if this collection contains all elements of another collection.

containsAll

(alias) pure function ~~containsAll~~(values: collection<-T>): boolean

Check if this collection contains all elements of another collection.

Alias

contains_all

empty

pure function empty(): boolean

Check if this collection is empty.

join_to_text

pure function join_to_text([separator: text], [prefix: text], [postfix: text], [limit: integer?], [truncated: text], [transform: (T) -> text]): text

Generate a textual representation of this iterable.

An optional separator, prefix and postfix can be provided. One can also provide a limit: integer?. If there are more elements in the result than limit, the elements whose indices exceed limit are omitted, and the passed truncated: text is included instead.

Examples:

[1, 2, 3].join_to_text() returns '1, 2, 3'.
[1, 2, 3].join_to_text('_') returns '1_2_3'.
[1, 2, 3].join_to_text('*', '(', ')') returns '(1*2*3)'.
list<T>().join_to_text('!', '(', ')') returns '()' (where T is a valid type).
range(10).join_to_text('', '', '', 5) returns '01234...'.
range(10).join_to_text('', '', '', 5, 'more') returns '01234more'.

Where the function even is defined:

function even(x: integer): text {
   return if (x % 2 == 0) 'EVEN' else 'ODD';
}

Then:

range(10).join_to_text('->', '{', '}', 5, '...', even(*)) returns {EVEN->ODD->EVEN->ODD->EVEN->...}.

len

(alias) pure function ~~len~~(): integer

Get the size (number of elements) of this collection.

Alias

size

remove

function remove(value: T): boolean

Remove an element from this collection.

remove_all

function remove_all(values: collection<-T>): boolean

Remove all elements in another collection from this collection.

remove_all_copy

function remove_all_copy(values: collection<-T>): set<T>

Returns a new set containing the elements of this set, but without any elements that occur in the given collection.

a.remove_all_copy(b) is equivalent to a - b, where a and b are sets.

Examples:

set([1]).remove_all_copy(set([1])) returns set([])
set([1, 2, 3]).remove_all_copy(set([2, 3, 4])) returns set([1])

removeAll

(alias) function ~~removeAll~~(values: collection<-T>): boolean

Remove all elements in another collection from this collection.

Alias

remove_all

retain_all

function retain_all(values: collection<-T>): boolean

Retain in this collection only those elements found in the given collection. In other words, remove from this collection all elements that are not found in the given collection.

retain_all_copy

function retain_all_copy(values: collection<-T>): set<T>

Returns a new set whose elements are those found in both this set and the given collection, or in other words, the intersection of this set and the given collection.

size